<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::Adam&lt; SearchPointType &gt; Class Template Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_adam.html">Adam</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_adam-members.html">List of all members</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::Adam&lt; SearchPointType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__optimizers.html">Algorithms to find a local minimum of\ref objfunctions.</a> &raquo; <a class="el" href="group__gradientopt.html">Gradient-based Single objective optimizers</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Adaptive Moment Estimation Algorithm (ADAM)  
 <a href="classshark_1_1_adam.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_adam_8h_source.html">shark/Algorithms/GradientDescent/Adam.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for shark::Adam&lt; SearchPointType &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classshark_1_1_adam__inherit__graph.png" border="0" usemap="#ashark_1_1_adam_3_01_search_point_type_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ashark_1_1_adam_3_01_search_point_type_01_4_inherit__map" id="ashark_1_1_adam_3_01_search_point_type_01_4_inherit__map">
<area shape="rect" title="Adaptive Moment Estimation Algorithm (ADAM)" alt="" coords="17,94,195,135"/>
<area shape="rect" href="classshark_1_1_abstract_single_objective_optimizer.html" title="Base class for all single objective optimizer." alt="" coords="5,5,207,46"/>
<area shape="poly" title=" " alt="" coords="109,62,109,94,103,94,103,62"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aea81fcabb518f78a48419b4416563a6d" id="r_aea81fcabb518f78a48419b4416563a6d"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_abstract_objective_function.html">AbstractObjectiveFunction</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#aea81fcabb518f78a48419b4416563a6d">ObjectiveFunctionType</a></td></tr>
<tr class="separator:aea81fcabb518f78a48419b4416563a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classshark_1_1_abstract_single_objective_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classshark_1_1_abstract_single_objective_optimizer')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;</a></td></tr>
<tr class="memitem:a85f0d04fdfb094dba4dc80b1fb5e3adb inherit pub_types_classshark_1_1_abstract_single_objective_optimizer" id="r_a85f0d04fdfb094dba4dc80b1fb5e3adb"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_abstract_optimizer.html#abea8df343e5638782a9a82403adb5ae1">base_type::SearchPointType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a></td></tr>
<tr class="separator:a85f0d04fdfb094dba4dc80b1fb5e3adb inherit pub_types_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8abcd574faa4b7bd2fed03465d1eda35 inherit pub_types_classshark_1_1_abstract_single_objective_optimizer" id="r_a8abcd574faa4b7bd2fed03465d1eda35"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_abstract_optimizer.html#abc94d354dbe0b99c0a69ec3e6e5e8657">base_type::SolutionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a8abcd574faa4b7bd2fed03465d1eda35">SolutionType</a></td></tr>
<tr class="separator:a8abcd574faa4b7bd2fed03465d1eda35 inherit pub_types_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a068a68c8739215f4a13ce8a433ec38b3 inherit pub_types_classshark_1_1_abstract_single_objective_optimizer" id="r_a068a68c8739215f4a13ce8a433ec38b3"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_abstract_optimizer.html#a89ed73f010deb3809acbcf23160c0f6b">base_type::ResultType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a068a68c8739215f4a13ce8a433ec38b3">ResultType</a></td></tr>
<tr class="separator:a068a68c8739215f4a13ce8a433ec38b3 inherit pub_types_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4c05609c54d7ebc99d099e7dd6e228f inherit pub_types_classshark_1_1_abstract_single_objective_optimizer" id="r_aa4c05609c54d7ebc99d099e7dd6e228f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_abstract_optimizer.html#ac7a9b0634e5a5cbd683f5510b41b7062">base_type::ObjectiveFunctionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#aa4c05609c54d7ebc99d099e7dd6e228f">ObjectiveFunctionType</a></td></tr>
<tr class="separator:aa4c05609c54d7ebc99d099e7dd6e228f inherit pub_types_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classshark_1_1_abstract_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classshark_1_1_abstract_optimizer')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classshark_1_1_abstract_optimizer.html">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;</a></td></tr>
<tr class="memitem:a77bf437afee3445601c680cc652410f0 inherit pub_types_classshark_1_1_abstract_optimizer" id="r_a77bf437afee3445601c680cc652410f0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a77bf437afee3445601c680cc652410f0">Feature</a> </td></tr>
<tr class="memdesc:a77bf437afee3445601c680cc652410f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Models features that the optimizer requires from the objective function.  <a href="classshark_1_1_abstract_optimizer.html#a77bf437afee3445601c680cc652410f0">More...</a><br /></td></tr>
<tr class="separator:a77bf437afee3445601c680cc652410f0 inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abea8df343e5638782a9a82403adb5ae1 inherit pub_types_classshark_1_1_abstract_optimizer" id="r_abea8df343e5638782a9a82403adb5ae1"><td class="memItemLeft" align="right" valign="top">typedef PointType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#abea8df343e5638782a9a82403adb5ae1">SearchPointType</a></td></tr>
<tr class="separator:abea8df343e5638782a9a82403adb5ae1 inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ed73f010deb3809acbcf23160c0f6b inherit pub_types_classshark_1_1_abstract_optimizer" id="r_a89ed73f010deb3809acbcf23160c0f6b"><td class="memItemLeft" align="right" valign="top">typedef double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a89ed73f010deb3809acbcf23160c0f6b">ResultType</a></td></tr>
<tr class="separator:a89ed73f010deb3809acbcf23160c0f6b inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc94d354dbe0b99c0a69ec3e6e5e8657 inherit pub_types_classshark_1_1_abstract_optimizer" id="r_abc94d354dbe0b99c0a69ec3e6e5e8657"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structshark_1_1_single_objective_result_set.html">SingleObjectiveResultSet</a>&lt; PointType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#abc94d354dbe0b99c0a69ec3e6e5e8657">SolutionType</a></td></tr>
<tr class="separator:abc94d354dbe0b99c0a69ec3e6e5e8657 inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7a9b0634e5a5cbd683f5510b41b7062 inherit pub_types_classshark_1_1_abstract_optimizer" id="r_ac7a9b0634e5a5cbd683f5510b41b7062"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_abstract_objective_function.html">AbstractObjectiveFunction</a>&lt; PointType, <a class="el" href="classshark_1_1_abstract_optimizer.html#a89ed73f010deb3809acbcf23160c0f6b">ResultType</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#ac7a9b0634e5a5cbd683f5510b41b7062">ObjectiveFunctionType</a></td></tr>
<tr class="separator:ac7a9b0634e5a5cbd683f5510b41b7062 inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab43ff108d945a982e98495432ace599f inherit pub_types_classshark_1_1_abstract_optimizer" id="r_ab43ff108d945a982e98495432ace599f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_typed_flags.html">TypedFlags</a>&lt; <a class="el" href="classshark_1_1_abstract_optimizer.html#a77bf437afee3445601c680cc652410f0">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#ab43ff108d945a982e98495432ace599f">Features</a></td></tr>
<tr class="separator:ab43ff108d945a982e98495432ace599f inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47751327ce0519d3378a9b2ad188d1e6 inherit pub_types_classshark_1_1_abstract_optimizer" id="r_a47751327ce0519d3378a9b2ad188d1e6"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classshark_1_1_typed_feature_not_available_exception.html">TypedFeatureNotAvailableException</a>&lt; <a class="el" href="classshark_1_1_abstract_optimizer.html#a77bf437afee3445601c680cc652410f0">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a47751327ce0519d3378a9b2ad188d1e6">FeatureNotAvailableException</a></td></tr>
<tr class="separator:a47751327ce0519d3378a9b2ad188d1e6 inherit pub_types_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5710b74b45246dc8edbc377ecaf0292a" id="r_a5710b74b45246dc8edbc377ecaf0292a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a5710b74b45246dc8edbc377ecaf0292a">Adam</a> ()</td></tr>
<tr class="separator:a5710b74b45246dc8edbc377ecaf0292a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a904590aed2428f855aa96a85ec7d6d64" id="r_a904590aed2428f855aa96a85ec7d6d64"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a904590aed2428f855aa96a85ec7d6d64">name</a> () const</td></tr>
<tr class="memdesc:a904590aed2428f855aa96a85ec7d6d64"><td class="mdescLeft">&#160;</td><td class="mdescRight">From <a class="el" href="classshark_1_1_i_nameable.html" title="This class is an interface for all objects which can have a name.">INameable</a>: return the class name.  <br /></td></tr>
<tr class="separator:a904590aed2428f855aa96a85ec7d6d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05893bc5dc81a6fccd0b9a0a15415770" id="r_a05893bc5dc81a6fccd0b9a0a15415770"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a05893bc5dc81a6fccd0b9a0a15415770">init</a> (<a class="el" href="classshark_1_1_adam.html#aea81fcabb518f78a48419b4416563a6d">ObjectiveFunctionType</a> const &amp;objectiveFunction, <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> const &amp;startingPoint)</td></tr>
<tr class="separator:a05893bc5dc81a6fccd0b9a0a15415770"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33cc65bf96984af7cce5788520ccad61" id="r_a33cc65bf96984af7cce5788520ccad61"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a33cc65bf96984af7cce5788520ccad61">eta</a> () const</td></tr>
<tr class="memdesc:a33cc65bf96984af7cce5788520ccad61"><td class="mdescLeft">&#160;</td><td class="mdescRight">get learning rate eta  <br /></td></tr>
<tr class="separator:a33cc65bf96984af7cce5788520ccad61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8cda0391795c0e586a5dfcef078b15e" id="r_aa8cda0391795c0e586a5dfcef078b15e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#aa8cda0391795c0e586a5dfcef078b15e">setEta</a> (double <a class="el" href="classshark_1_1_adam.html#a33cc65bf96984af7cce5788520ccad61">eta</a>)</td></tr>
<tr class="memdesc:aa8cda0391795c0e586a5dfcef078b15e"><td class="mdescLeft">&#160;</td><td class="mdescRight">set learning rate eta  <br /></td></tr>
<tr class="separator:aa8cda0391795c0e586a5dfcef078b15e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcabef3366290b075d51294876732613" id="r_afcabef3366290b075d51294876732613"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#afcabef3366290b075d51294876732613">beta1</a> () const</td></tr>
<tr class="memdesc:afcabef3366290b075d51294876732613"><td class="mdescLeft">&#160;</td><td class="mdescRight">get gradient averaging parameter beta1  <br /></td></tr>
<tr class="separator:afcabef3366290b075d51294876732613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab57d8b444cd86e5fc5b67ae7c38c9ab7" id="r_ab57d8b444cd86e5fc5b67ae7c38c9ab7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#ab57d8b444cd86e5fc5b67ae7c38c9ab7">setBeta1</a> (double <a class="el" href="classshark_1_1_adam.html#afcabef3366290b075d51294876732613">beta1</a>)</td></tr>
<tr class="memdesc:ab57d8b444cd86e5fc5b67ae7c38c9ab7"><td class="mdescLeft">&#160;</td><td class="mdescRight">set gradient averaging parameter beta1  <br /></td></tr>
<tr class="separator:ab57d8b444cd86e5fc5b67ae7c38c9ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13b7618dea5584ffd886c15858d02888" id="r_a13b7618dea5584ffd886c15858d02888"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a13b7618dea5584ffd886c15858d02888">beta2</a> () const</td></tr>
<tr class="memdesc:a13b7618dea5584ffd886c15858d02888"><td class="mdescLeft">&#160;</td><td class="mdescRight">get gradient averaging parameter beta2  <br /></td></tr>
<tr class="separator:a13b7618dea5584ffd886c15858d02888"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a33672d62b05085d9c12000c38c4ff4" id="r_a6a33672d62b05085d9c12000c38c4ff4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a6a33672d62b05085d9c12000c38c4ff4">setBeta2</a> (double <a class="el" href="classshark_1_1_adam.html#a13b7618dea5584ffd886c15858d02888">beta2</a>)</td></tr>
<tr class="memdesc:a6a33672d62b05085d9c12000c38c4ff4"><td class="mdescLeft">&#160;</td><td class="mdescRight">set gradient averaging parameter beta2  <br /></td></tr>
<tr class="separator:a6a33672d62b05085d9c12000c38c4ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84ea9e08b7ed6e18a23e706ba63441ff" id="r_a84ea9e08b7ed6e18a23e706ba63441ff"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#a84ea9e08b7ed6e18a23e706ba63441ff">epsilon</a> () const</td></tr>
<tr class="memdesc:a84ea9e08b7ed6e18a23e706ba63441ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">get minimum noise estimate epsilon  <br /></td></tr>
<tr class="separator:a84ea9e08b7ed6e18a23e706ba63441ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad976d2e3215eca56dedbe305b327d405" id="r_ad976d2e3215eca56dedbe305b327d405"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#ad976d2e3215eca56dedbe305b327d405">setEpsilon</a> (double <a class="el" href="classshark_1_1_adam.html#a84ea9e08b7ed6e18a23e706ba63441ff">epsilon</a>)</td></tr>
<tr class="memdesc:ad976d2e3215eca56dedbe305b327d405"><td class="mdescLeft">&#160;</td><td class="mdescRight">set minimum noise estimate epsilon  <br /></td></tr>
<tr class="separator:ad976d2e3215eca56dedbe305b327d405"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad42982976c3e91534ac33999d7c6fc3" id="r_aad42982976c3e91534ac33999d7c6fc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#aad42982976c3e91534ac33999d7c6fc3">step</a> (<a class="el" href="classshark_1_1_adam.html#aea81fcabb518f78a48419b4416563a6d">ObjectiveFunctionType</a> const &amp;objectiveFunction)</td></tr>
<tr class="memdesc:aad42982976c3e91534ac33999d7c6fc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a step of the optimization.  <br /></td></tr>
<tr class="separator:aad42982976c3e91534ac33999d7c6fc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0560f21fb8e543bd040c37e3ba3a35e" id="r_ab0560f21fb8e543bd040c37e3ba3a35e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#ab0560f21fb8e543bd040c37e3ba3a35e">read</a> (<a class="el" href="namespaceshark.html#ada68729491840669e47c8ad42282424f">InArchive</a> &amp;archive)</td></tr>
<tr class="memdesc:ab0560f21fb8e543bd040c37e3ba3a35e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the component from the supplied archive.  <br /></td></tr>
<tr class="separator:ab0560f21fb8e543bd040c37e3ba3a35e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff40083e249cf987ca9232c4af82138b" id="r_aff40083e249cf987ca9232c4af82138b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_adam.html#aff40083e249cf987ca9232c4af82138b">write</a> (<a class="el" href="namespaceshark.html#af4f8eb8e9618f5236b71bbcb12b8a524">OutArchive</a> &amp;archive) const</td></tr>
<tr class="memdesc:aff40083e249cf987ca9232c4af82138b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the component to the supplied archive.  <br /></td></tr>
<tr class="separator:aff40083e249cf987ca9232c4af82138b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_abstract_single_objective_optimizer')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;</a></td></tr>
<tr class="memitem:a1bd54036e3524dc2ddf02afeadc0939f inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer" id="r_a1bd54036e3524dc2ddf02afeadc0939f"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a1bd54036e3524dc2ddf02afeadc0939f">numInitPoints</a> () const</td></tr>
<tr class="memdesc:a1bd54036e3524dc2ddf02afeadc0939f inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">By default most single objective optimizers only require a single point.  <br /></td></tr>
<tr class="separator:a1bd54036e3524dc2ddf02afeadc0939f inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a246f1f1d4e0566c9a0ca43035a63fad5 inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer" id="r_a246f1f1d4e0566c9a0ca43035a63fad5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a246f1f1d4e0566c9a0ca43035a63fad5">init</a> (<a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#aa4c05609c54d7ebc99d099e7dd6e228f">ObjectiveFunctionType</a> const &amp;function, std::vector&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt; const &amp;initPoints)</td></tr>
<tr class="memdesc:a246f1f1d4e0566c9a0ca43035a63fad5 inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the optimizer for the supplied objective function using a set of initialisation points.  <br /></td></tr>
<tr class="separator:a246f1f1d4e0566c9a0ca43035a63fad5 inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae53c1a8348f5ab987f5aa8829fd8020f inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer" id="r_ae53c1a8348f5ab987f5aa8829fd8020f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#ae53c1a8348f5ab987f5aa8829fd8020f">init</a> (<a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#aa4c05609c54d7ebc99d099e7dd6e228f">ObjectiveFunctionType</a> const &amp;function, <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> const &amp;startingPoint)=0</td></tr>
<tr class="memdesc:ae53c1a8348f5ab987f5aa8829fd8020f inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes the optimizer using a predefined starting point  <br /></td></tr>
<tr class="separator:ae53c1a8348f5ab987f5aa8829fd8020f inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0909596fcc4f80a8d108859b20b64a81 inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer" id="r_a0909596fcc4f80a8d108859b20b64a81"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a8abcd574faa4b7bd2fed03465d1eda35">SolutionType</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a0909596fcc4f80a8d108859b20b64a81">solution</a> () const</td></tr>
<tr class="memdesc:a0909596fcc4f80a8d108859b20b64a81 inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the current solution of the optimizer  <br /></td></tr>
<tr class="separator:a0909596fcc4f80a8d108859b20b64a81 inherit pub_methods_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_abstract_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_abstract_optimizer')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_abstract_optimizer.html">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;</a></td></tr>
<tr class="memitem:a40334039f6e799b2255d229874e9fa39 inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_a40334039f6e799b2255d229874e9fa39"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classshark_1_1_abstract_optimizer.html#ab43ff108d945a982e98495432ace599f">Features</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a40334039f6e799b2255d229874e9fa39">features</a> () const</td></tr>
<tr class="separator:a40334039f6e799b2255d229874e9fa39 inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc0219242dff14757398c81d2e82c22e inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_adc0219242dff14757398c81d2e82c22e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#adc0219242dff14757398c81d2e82c22e">updateFeatures</a> ()</td></tr>
<tr class="separator:adc0219242dff14757398c81d2e82c22e inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8645fb354408c89d3537aa87aed49b79 inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_a8645fb354408c89d3537aa87aed49b79"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a8645fb354408c89d3537aa87aed49b79">requiresValue</a> () const</td></tr>
<tr class="separator:a8645fb354408c89d3537aa87aed49b79 inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13dff098bcde14529b64be653d73d57f inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_a13dff098bcde14529b64be653d73d57f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a13dff098bcde14529b64be653d73d57f">requiresFirstDerivative</a> () const</td></tr>
<tr class="separator:a13dff098bcde14529b64be653d73d57f inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9da146985b7738554e09f75a670f8c97 inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_a9da146985b7738554e09f75a670f8c97"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a9da146985b7738554e09f75a670f8c97">requiresSecondDerivative</a> () const</td></tr>
<tr class="separator:a9da146985b7738554e09f75a670f8c97 inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecad1d60d38fd243eaf7c7bf0f6d01af inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_aecad1d60d38fd243eaf7c7bf0f6d01af"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#aecad1d60d38fd243eaf7c7bf0f6d01af">canSolveConstrained</a> () const</td></tr>
<tr class="separator:aecad1d60d38fd243eaf7c7bf0f6d01af inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9332ad1b90deed11ee6709a92964bc9 inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_aa9332ad1b90deed11ee6709a92964bc9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#aa9332ad1b90deed11ee6709a92964bc9">requiresClosestFeasible</a> () const</td></tr>
<tr class="separator:aa9332ad1b90deed11ee6709a92964bc9 inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd45149f57784a117e8f62d0763bf891 inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_abd45149f57784a117e8f62d0763bf891"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#abd45149f57784a117e8f62d0763bf891">~AbstractOptimizer</a> ()</td></tr>
<tr class="separator:abd45149f57784a117e8f62d0763bf891 inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa65e7eece1d248594253b799cf20e7a inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_aaa65e7eece1d248594253b799cf20e7a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#aaa65e7eece1d248594253b799cf20e7a">init</a> (<a class="el" href="classshark_1_1_abstract_optimizer.html#ac7a9b0634e5a5cbd683f5510b41b7062">ObjectiveFunctionType</a> const &amp;function)</td></tr>
<tr class="memdesc:aaa65e7eece1d248594253b799cf20e7a inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the optimizer for the supplied objective function.  <br /></td></tr>
<tr class="separator:aaa65e7eece1d248594253b799cf20e7a inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfc507951eb09c50d62c474c79d773ea inherit pub_methods_classshark_1_1_abstract_optimizer" id="r_abfc507951eb09c50d62c474c79d773ea"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#abfc507951eb09c50d62c474c79d773ea">step</a> (<a class="el" href="classshark_1_1_abstract_optimizer.html#ac7a9b0634e5a5cbd683f5510b41b7062">ObjectiveFunctionType</a> const &amp;function)=0</td></tr>
<tr class="memdesc:abfc507951eb09c50d62c474c79d773ea inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Carry out one step of the optimizer for the supplied objective function.  <br /></td></tr>
<tr class="separator:abfc507951eb09c50d62c474c79d773ea inherit pub_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_i_nameable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_i_nameable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_i_nameable.html">shark::INameable</a></td></tr>
<tr class="memitem:a877dbdfc6b58ea836495143cea44a98c inherit pub_methods_classshark_1_1_i_nameable" id="r_a877dbdfc6b58ea836495143cea44a98c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_i_nameable.html#a877dbdfc6b58ea836495143cea44a98c">~INameable</a> ()</td></tr>
<tr class="separator:a877dbdfc6b58ea836495143cea44a98c inherit pub_methods_classshark_1_1_i_nameable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_i_serializable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_i_serializable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_i_serializable.html">shark::ISerializable</a></td></tr>
<tr class="memitem:a7baa9ce108d7278822297ce15882782a inherit pub_methods_classshark_1_1_i_serializable" id="r_a7baa9ce108d7278822297ce15882782a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_i_serializable.html#a7baa9ce108d7278822297ce15882782a">~ISerializable</a> ()</td></tr>
<tr class="memdesc:a7baa9ce108d7278822297ce15882782a inherit pub_methods_classshark_1_1_i_serializable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual d'tor.  <br /></td></tr>
<tr class="separator:a7baa9ce108d7278822297ce15882782a inherit pub_methods_classshark_1_1_i_serializable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdda0c5b8e065b8afbac2cba8f58e841 inherit pub_methods_classshark_1_1_i_serializable" id="r_abdda0c5b8e065b8afbac2cba8f58e841"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_i_serializable.html#abdda0c5b8e065b8afbac2cba8f58e841">load</a> (<a class="el" href="namespaceshark.html#ada68729491840669e47c8ad42282424f">InArchive</a> &amp;archive, unsigned int version)</td></tr>
<tr class="memdesc:abdda0c5b8e065b8afbac2cba8f58e841 inherit pub_methods_classshark_1_1_i_serializable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Versioned loading of components, calls read(...).  <br /></td></tr>
<tr class="separator:abdda0c5b8e065b8afbac2cba8f58e841 inherit pub_methods_classshark_1_1_i_serializable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bf66fa8db15cc529bec98976a2f5255 inherit pub_methods_classshark_1_1_i_serializable" id="r_a5bf66fa8db15cc529bec98976a2f5255"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_i_serializable.html#a5bf66fa8db15cc529bec98976a2f5255">save</a> (<a class="el" href="namespaceshark.html#af4f8eb8e9618f5236b71bbcb12b8a524">OutArchive</a> &amp;archive, unsigned int version) const</td></tr>
<tr class="memdesc:a5bf66fa8db15cc529bec98976a2f5255 inherit pub_methods_classshark_1_1_i_serializable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Versioned storing of components, calls write(...).  <br /></td></tr>
<tr class="separator:a5bf66fa8db15cc529bec98976a2f5255 inherit pub_methods_classshark_1_1_i_serializable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4560a94e8f4908fe8627e41e7d965735 inherit pub_methods_classshark_1_1_i_serializable" id="r_a4560a94e8f4908fe8627e41e7d965735"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_i_serializable.html#a4560a94e8f4908fe8627e41e7d965735">BOOST_SERIALIZATION_SPLIT_MEMBER</a> ()</td></tr>
<tr class="separator:a4560a94e8f4908fe8627e41e7d965735 inherit pub_methods_classshark_1_1_i_serializable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classshark_1_1_abstract_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshark_1_1_abstract_optimizer')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classshark_1_1_abstract_optimizer.html">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;</a></td></tr>
<tr class="memitem:ae7a23300641448c761b6aa0305b7ef66 inherit pro_methods_classshark_1_1_abstract_optimizer" id="r_ae7a23300641448c761b6aa0305b7ef66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#ae7a23300641448c761b6aa0305b7ef66">checkFeatures</a> (<a class="el" href="classshark_1_1_abstract_optimizer.html#ac7a9b0634e5a5cbd683f5510b41b7062">ObjectiveFunctionType</a> const &amp;objectiveFunction)</td></tr>
<tr class="memdesc:ae7a23300641448c761b6aa0305b7ef66 inherit pro_methods_classshark_1_1_abstract_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function that checks whether the features of the supplied objective function match with the required features of the optimizer.  <br /></td></tr>
<tr class="separator:ae7a23300641448c761b6aa0305b7ef66 inherit pro_methods_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classshark_1_1_abstract_single_objective_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classshark_1_1_abstract_single_objective_optimizer')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;</a></td></tr>
<tr class="memitem:a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0 inherit pro_attribs_classshark_1_1_abstract_single_objective_optimizer" id="r_a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a8abcd574faa4b7bd2fed03465d1eda35">SolutionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0">m_best</a></td></tr>
<tr class="memdesc:a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0 inherit pro_attribs_classshark_1_1_abstract_single_objective_optimizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current solution of the optimizer.  <br /></td></tr>
<tr class="separator:a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0 inherit pro_attribs_classshark_1_1_abstract_single_objective_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classshark_1_1_abstract_optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classshark_1_1_abstract_optimizer')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classshark_1_1_abstract_optimizer.html">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;</a></td></tr>
<tr class="memitem:a72daf583d406e144b90869f311baa594 inherit pro_attribs_classshark_1_1_abstract_optimizer" id="r_a72daf583d406e144b90869f311baa594"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_abstract_optimizer.html#ab43ff108d945a982e98495432ace599f">Features</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_optimizer.html#a72daf583d406e144b90869f311baa594">m_features</a></td></tr>
<tr class="separator:a72daf583d406e144b90869f311baa594 inherit pro_attribs_classshark_1_1_abstract_optimizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> = RealVector&gt;<br />
class shark::Adam&lt; SearchPointType &gt;</div><p>Adaptive Moment Estimation Algorithm (ADAM) </p>
<p>Performs SGD by using a long term average of the gradient as well as its second moment to adapt a step size for each coordinate. </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00047">47</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aea81fcabb518f78a48419b4416563a6d" name="aea81fcabb518f78a48419b4416563a6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea81fcabb518f78a48419b4416563a6d">&#9670;&#160;</a></span>ObjectiveFunctionType</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classshark_1_1_abstract_objective_function.html">AbstractObjectiveFunction</a>&lt;<a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>,double&gt; <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::ObjectiveFunctionType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00050">50</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5710b74b45246dc8edbc377ecaf0292a" name="a5710b74b45246dc8edbc377ecaf0292a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5710b74b45246dc8edbc377ecaf0292a">&#9670;&#160;</a></span>Adam()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::Adam </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00051">51</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_abstract_optimizer.html#a72daf583d406e144b90869f311baa594">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;::m_features</a>, and <a class="el" href="classshark_1_1_abstract_optimizer.html#a77bf437afee3445601c680cc652410f0ad9b925369d4f923c63792bf455eac1d7">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;::REQUIRES_FIRST_DERIVATIVE</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afcabef3366290b075d51294876732613" name="afcabef3366290b075d51294876732613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcabef3366290b075d51294876732613">&#9670;&#160;</a></span>beta1()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::beta1 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>get gradient averaging parameter beta1 </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00091">91</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_adam.html#ab57d8b444cd86e5fc5b67ae7c38c9ab7">shark::Adam&lt; SearchPointType &gt;::setBeta1()</a>.</p>

</div>
</div>
<a id="a13b7618dea5584ffd886c15858d02888" name="a13b7618dea5584ffd886c15858d02888"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13b7618dea5584ffd886c15858d02888">&#9670;&#160;</a></span>beta2()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::beta2 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>get gradient averaging parameter beta2 </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00102">102</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_adam.html#a6a33672d62b05085d9c12000c38c4ff4">shark::Adam&lt; SearchPointType &gt;::setBeta2()</a>.</p>

</div>
</div>
<a id="a84ea9e08b7ed6e18a23e706ba63441ff" name="a84ea9e08b7ed6e18a23e706ba63441ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ea9e08b7ed6e18a23e706ba63441ff">&#9670;&#160;</a></span>epsilon()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::epsilon </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>get minimum noise estimate epsilon </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00113">113</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_adam.html#ad976d2e3215eca56dedbe305b327d405">shark::Adam&lt; SearchPointType &gt;::setEpsilon()</a>.</p>

</div>
</div>
<a id="a33cc65bf96984af7cce5788520ccad61" name="a33cc65bf96984af7cce5788520ccad61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33cc65bf96984af7cce5788520ccad61">&#9670;&#160;</a></span>eta()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::eta </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>get learning rate eta </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00080">80</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_adam.html#aa8cda0391795c0e586a5dfcef078b15e">shark::Adam&lt; SearchPointType &gt;::setEta()</a>.</p>

</div>
</div>
<a id="a05893bc5dc81a6fccd0b9a0a15415770" name="a05893bc5dc81a6fccd0b9a0a15415770"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05893bc5dc81a6fccd0b9a0a15415770">&#9670;&#160;</a></span>init()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_adam.html#aea81fcabb518f78a48419b4416563a6d">ObjectiveFunctionType</a> const &amp;&#160;</td>
          <td class="paramname"><em>objectiveFunction</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> const &amp;&#160;</td>
          <td class="paramname"><em>startingPoint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00064">64</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_abstract_optimizer.html#ae7a23300641448c761b6aa0305b7ef66">shark::AbstractOptimizer&lt; PointType, double, SingleObjectiveResultSet&lt; PointType &gt; &gt;::checkFeatures()</a>, <a class="el" href="classshark_1_1_abstract_objective_function.html#a53df2ac5d82c608ea938dc1e3a0c0617">shark::AbstractObjectiveFunction&lt; PointType, ResultT &gt;::evalDerivative()</a>, <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;::m_best</a>, <a class="el" href="classshark_1_1_abstract_objective_function.html#a256f6b128af038dfaf9cef1bcd45a426">shark::AbstractObjectiveFunction&lt; PointType, ResultT &gt;::numberOfVariables()</a>, <a class="el" href="structshark_1_1_result_set.html#a5afb306cbdabb9ddb962eb22dbf79bb6">shark::ResultSet&lt; SearchPointT, ResultT &gt;::point</a>, <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>, and <a class="el" href="structshark_1_1_result_set.html#abfb2c7bc8ee3b184bbef15cb250ead50">shark::ResultSet&lt; SearchPointT, ResultT &gt;::value</a>.</p>

<p class="reference">Referenced by <a class="el" href="_f_f_n_n_basic_tutorial_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>

</div>
</div>
<a id="a904590aed2428f855aa96a85ec7d6d64" name="a904590aed2428f855aa96a85ec7d6d64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a904590aed2428f855aa96a85ec7d6d64">&#9670;&#160;</a></span>name()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::name </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>From <a class="el" href="classshark_1_1_i_nameable.html" title="This class is an interface for all objects which can have a name.">INameable</a>: return the class name. </p>

<p>Reimplemented from <a class="el" href="classshark_1_1_i_nameable.html#a9893f99314de30cd472e649c235d0db4">shark::INameable</a>.</p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00061">61</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

</div>
</div>
<a id="ab0560f21fb8e543bd040c37e3ba3a35e" name="ab0560f21fb8e543bd040c37e3ba3a35e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0560f21fb8e543bd040c37e3ba3a35e">&#9670;&#160;</a></span>read()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceshark.html#ada68729491840669e47c8ad42282424f">InArchive</a> &amp;&#160;</td>
          <td class="paramname"><em>archive</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read the component from the supplied archive. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">archive</td><td>The archive to read from. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classshark_1_1_i_serializable.html#ad4ad9a7c274deff642f91e98417fbc63">shark::ISerializable</a>.</p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00143">143</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;::m_best</a>.</p>

</div>
</div>
<a id="ab57d8b444cd86e5fc5b67ae7c38c9ab7" name="ab57d8b444cd86e5fc5b67ae7c38c9ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab57d8b444cd86e5fc5b67ae7c38c9ab7">&#9670;&#160;</a></span>setBeta1()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::setBeta1 </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>beta1</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>set gradient averaging parameter beta1 </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00096">96</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_adam.html#afcabef3366290b075d51294876732613">shark::Adam&lt; SearchPointType &gt;::beta1()</a>, and <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>.</p>

</div>
</div>
<a id="a6a33672d62b05085d9c12000c38c4ff4" name="a6a33672d62b05085d9c12000c38c4ff4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a33672d62b05085d9c12000c38c4ff4">&#9670;&#160;</a></span>setBeta2()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::setBeta2 </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>beta2</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>set gradient averaging parameter beta2 </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00107">107</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_adam.html#a13b7618dea5584ffd886c15858d02888">shark::Adam&lt; SearchPointType &gt;::beta2()</a>, and <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>.</p>

</div>
</div>
<a id="ad976d2e3215eca56dedbe305b327d405" name="ad976d2e3215eca56dedbe305b327d405"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad976d2e3215eca56dedbe305b327d405">&#9670;&#160;</a></span>setEpsilon()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::setEpsilon </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>epsilon</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>set minimum noise estimate epsilon </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00118">118</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_adam.html#a84ea9e08b7ed6e18a23e706ba63441ff">shark::Adam&lt; SearchPointType &gt;::epsilon()</a>, and <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>.</p>

</div>
</div>
<a id="aa8cda0391795c0e586a5dfcef078b15e" name="aa8cda0391795c0e586a5dfcef078b15e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8cda0391795c0e586a5dfcef078b15e">&#9670;&#160;</a></span>setEta()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::setEta </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>eta</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>set learning rate eta </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00085">85</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_adam.html#a33cc65bf96984af7cce5788520ccad61">shark::Adam&lt; SearchPointType &gt;::eta()</a>, and <a class="el" href="_exception_8h.html#adce1f80097c69010f5eab2618fa2e971">SHARK_RUNTIME_CHECK</a>.</p>

<p class="reference">Referenced by <a class="el" href="_m_n_i_s_t_for_experts_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>

</div>
</div>
<a id="aad42982976c3e91534ac33999d7c6fc3" name="aad42982976c3e91534ac33999d7c6fc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad42982976c3e91534ac33999d7c6fc3">&#9670;&#160;</a></span>step()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::step </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_adam.html#aea81fcabb518f78a48419b4416563a6d">ObjectiveFunctionType</a> const &amp;&#160;</td>
          <td class="paramname"><em>objectiveFunction</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Performs a step of the optimization. </p>
<p>First the current guess for gradient and its second moment are updated using </p><p class="formulaDsp">
\[ g_t = \beta_1 g_{t-1} + (1-\beta1) \frac{\partial}{\partial x} f(x_{t-1})\]
</p>
 <p class="formulaDsp">
\[ v_t = \beta_2 v_{t-1} + (1-\beta2) (\frac{\partial}{\partial x} f(x_{t-1}))^2\]
</p>
<p>The step is then performed as </p><p class="formulaDsp">
\[ x_{t} = x_{t-1} - \eta * g_t *(sqrt(v_t) + \epsilon)^{-1} \]
</p>
<p> where a slight step correction is used to remove the bias in the first few iterations where the means are close to 0. </p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00131">131</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_abstract_objective_function.html#a53df2ac5d82c608ea938dc1e3a0c0617">shark::AbstractObjectiveFunction&lt; PointType, ResultT &gt;::evalDerivative()</a>, <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;::m_best</a>, <a class="el" href="structshark_1_1_result_set.html#a5afb306cbdabb9ddb962eb22dbf79bb6">shark::ResultSet&lt; SearchPointT, ResultT &gt;::point</a>, <a class="el" href="group__shark__globals.html#gae1f82613484173e9fe1a07960dabff63">shark::sqr()</a>, and <a class="el" href="structshark_1_1_result_set.html#abfb2c7bc8ee3b184bbef15cb250ead50">shark::ResultSet&lt; SearchPointT, ResultT &gt;::value</a>.</p>

<p class="reference">Referenced by <a class="el" href="_f_f_n_n_basic_tutorial_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>

</div>
</div>
<a id="aff40083e249cf987ca9232c4af82138b" name="aff40083e249cf987ca9232c4af82138b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff40083e249cf987ca9232c4af82138b">&#9670;&#160;</a></span>write()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a>  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classshark_1_1_adam.html">shark::Adam</a>&lt; <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a85f0d04fdfb094dba4dc80b1fb5e3adb">SearchPointType</a> &gt;::write </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceshark.html#af4f8eb8e9618f5236b71bbcb12b8a524">OutArchive</a> &amp;&#160;</td>
          <td class="paramname"><em>archive</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Write the component to the supplied archive. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">archive</td><td>The archive to write to. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classshark_1_1_i_serializable.html#a9bddedd42933c922e323b73131f62f12">shark::ISerializable</a>.</p>

<p class="definition">Definition at line <a class="el" href="_adam_8h_source.html#l00156">156</a> of file <a class="el" href="_adam_8h_source.html">Adam.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_abstract_single_objective_optimizer.html#a4740a0f8e9d5c7d99cf0dd0c3ee0e8a0">shark::AbstractSingleObjectiveOptimizer&lt; PointType &gt;::m_best</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Algorithms/GradientDescent/<a class="el" href="_adam_8h_source.html">Adam.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
